MailDelivery.h

Go to the documentation of this file.

#ifndef MAILDELIVERY_H_
#define MAILDELIVERY_H_
/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
#define TRUE (1u)
#endif
#ifndef CLEAR
#define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
#define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
#define BITS_IN_BYTE (8u)
#endif
#ifndef BITS_IN_32
#define BITS_IN_32  (32u)
#endif
#ifndef BITS_IN_16
#define BITS_IN_16  (16u)
#endif
#ifndef BYTES_IN_32
#define BYTES_IN_32  (4u)
#endif
#ifndef BYTES_IN_16
#define BYTES_IN_16  (2u)
#endif

/* Mail DMAs */
#define MAILDELIVERY_OUTBOX1_DMA_CH (0x0Eu)
#define MAILDELIVERY_OUTBOX2_DMA_CH (0x0Fu)
#define MAILDELIVERY_INBOX1_DMA_CH  (0x0Cu)
#define MAILDELIVERY_INBOX2_DMA_CH  (0x0Du)

#define MAILDELIVERY_INBOX1_DMA_INDEX_START   (0u)
#define MAILDELIVERY_INBOX1_DMA_INDEX_END     (INBOX_MAX_BUFFER_CNT - 1)
#define MAILDELIVERY_INBOX2_DMA_INDEX_START   (INBOX_MAX_BUFFER_CNT)
#define MAILDELIVERY_INBOX2_DMA_INDEX_END     ((INBOX_MAX_BUFFER_CNT * 2u) - 1u)

/* Maximum number of messages */
#define OUTBOX_MAX_BUFFER_CNT (48u)
#define INBOX_MAX_BUFFER_CNT  (48u)

/* Permissions */
#define MAILBOX_WRITING_ALLOWED    (0xA0u)
#define MAILBOX_WRITING_PROHIBITED (0x0Au)

/* Define contents of mailboxes according to position */
#define OUTBOX_ACTIVE_OUTBOX_IS_1 (0u)
#define OUTBOX_ACTIVE_OUTBOX_IS_2 (OUTBOX_MAX_BUFFER_CNT + 1u)
#define MAILBOX_ACTIVE_INBOX_IS_1  (-1)
#define MAILBOX_ACTIVE_INBOX_IS_2 (-2)
#define MAILBOX_NO_PREVIOUS_INBOX (0u)

/* Define error codes */
#define MAILBOX_CAPACITY_HAS_BEEN_REACHED (0x20u)
#define MAILBOX_IS_BEING_WRITTEN          (0x10u)

/*** Function Macros ***/
/* This macro is here to replace vfnMailDeliveryTriggerOutbox
#define TRIGGER_OUTBOX(XX, YY) vfnDMAMUXInit(XX, DMA_SOURCE_DSPI0_TX, CLEAR, YY)
/*** Enums ***/

/*** TypeDefs ***/

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Constants ***/

/*** Globals ***/
extern vuint32_t gau32DSPIOutbox[(OUTBOX_MAX_BUFFER_CNT + 1u) * 2u];
extern vuint16_t gau16DSPIInbox[OUTBOX_MAX_BUFFER_CNT + 1u];
extern vuint8_t gu8MailboxActiveOutboxOffset;
extern vuint8_t gu8InboxDMA;
extern vuint8_t gu8InactiveInboxDMA;
extern vuint8_t gu8OutboxDMA;
extern vuint8_t gu8InactiveOutboxDMA;
/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          u8fnMailDeliveryOfOutboxInit()
 *
 */
uint8_t u8fnMailDeliveryOfOutboxInit(uint32_t* pu32Outbox, 
                                     uint32_t* pu32Output,
                                     uint8_t u8DMAChannel);
/*
 ******************************************************************************
 *
 * Function:          u8fnMailDeliveryToInboxInit()
 *
 */
uint8_t u8fnMailDeliveryToInboxInit(uint16_t* pu16Input);
/*
 ******************************************************************************
 *
 * Function:          vfnMailboxInit()
 *
 */
void vfnMailboxInit(void);
/*
 ******************************************************************************
 *
 * Function:          u8fnMailboxAppendToDSPIOutbox()
 *
 */
uint8_t u8fnMailboxAppendToDSPIOutbox(uint8_t u8DSPIInstance, uint8_t u8CS,
                                      uint8_t u8ContCS,
                                      uint8_t u8EndOfQueueFlag,
                                      uint16_t* pu16Msg, uint16_t u16Size);
/*
 ******************************************************************************
 *
 * Function:          u8fnMailboxAppendToCompositeDSPIOutbox()
 *
 */
uint8_t u8fnMailboxAppendToCompositeDSPIOutbox(uint8_t u8DSPIInstance1,
                                               uint8_t u8DSPIInstance2, 
                                               uint8_t u8CS,
                                               uint16_t* pu16Msg1, 
                                               uint16_t* pu16Msg2,
                                               uint16_t u16SizeAtOrigin);
/*
 ******************************************************************************
 *
 * Function:          u8fnMailboxAppendToOutbox()
 *
 */
uint8_t u8fnMailboxAppendToOutbox(uint32_t* pu32Mailbox, uint32_t u32Message);
/*
 ******************************************************************************
 *
 * Function:          u8fnMailboxAppendToInbox()
 *
 */
uint8_t u8fnMailboxAppendToInbox(const uint16_t* pu16MsgResponse,
                                 uint16_t u16Size);
/*
 ******************************************************************************
 *
 * Function:          vfnMailboxSwitchActiveMailboxes()
 *
 */
void vfnMailboxSwitchActiveMailboxes(void);
/*
 ******************************************************************************
 *
 * Function:          vfnMailDeliveryTriggerOutbox()
 *
 */
void vfnMailDeliveryTriggerOutbox(uint8_t u8DMAMuxChannel, uint8_t u8Enable);
#endif /* MAILDELIVERY_H_ */